Модуль string

Общие сведения

Модуль string включает в себя всё из стандартной библиотеки для работы со строками в Lua, а также некоторые расширения специально для Tarantool’а.

В данном разделе мы рассматриваем только дополнительные функции, добавленные разработчиками Tarantool’а.

Ниже приведен перечень всех функций библиотеки string.

string.ljust(input-string, width[, pad-character])

Возврат строки, выровненной по левому краю, шириной, указанной в width.

Параметры:	input-string (string) – строка для выравнивания по левому краю width (integer) – ширина строки после выравнивания по левому краю pad-character (string) – отдельный символ, по умолчанию = 1 пробел
Возвращается:	выровненная по левому краю строка (не изменяется, если ширина <= длине строки)
Тип возвращаемого значения:
	строка

Пример:

tarantool> string = require('string')
---
...
tarantool> string.ljust(' A', 5)
---
- ' A   '
...

string.rjust(input-string, width[, pad-character])

Возврат строки, выровненной по правому краю, шириной, указанной в width.

Параметры:	input-string (string) – строка для выравнивания по правому краю width (integer) – ширина строки после выравнивания по правому краю pad-character (string) – отдельный символ, по умолчанию = 1 пробел
Возвращается:	выровненная по правому краю строка (не изменяется, если ширина <= длине строки)
Тип возвращаемого значения:
	строка

Пример:

tarantool> string = require('string')
---
...
tarantool> string.rjust('', 5, 'X')
---
- 'XXXXX'
...

string.hex(input-string)

Возврат шестнадцатеричного значения введенной строки.

Параметры:	input-string (string) – обрабатываемая строка
Возвращается:	шестнадцатеричное число, два символа шестнадцатеричных цифр для каждого введенного символа
Тип возвращаемого значения:
	строка

Пример:

tarantool> string = require('string')
---
...
tarantool> string.hex('ABC ')
---
- '41424320'
...

string.startswith(input-string, start-string[, start-pos[, end-pos]])

Возврат true (правда), если input-string начинается со start-string, в противном случае, возврат false (ложь).

Параметры:	input-string (string) – строка, где производится поиск данных из start-string start-string (string) – искомая строка start-pos (integer) – положение: где начинать искать в пределах input-string end-pos (integer) – положение: где заканчивать искать в пределах input-string
Возвращается:	true (правда) или false (ложь)
Тип возвращаемого значения:
	boolean (логический)

Значения start-pos и end-pos могут быть отрицательными, что означает, что положение вычисляется с конца строки.

Пример:

tarantool> string = require('string')
---
...
tarantool> string.startswith(' A', 'A', 2, 5)
---
- true
...

string.endswith(input-string, end-string[, start-pos[, end-pos]])

Возврат true (правда), если input-string заканчивается на end-string, в противном случае, возврат false (ложь).

Параметры:	input-string (string) – строка, где производится поиск данных из end-string end-string (string) – искомая строка start-pos (integer) – положение: где начинать искать в пределах input-string end-pos (integer) – положение: где заканчивать искать в пределах input-string
Возвращается:	true (правда) или false (ложь)
Тип возвращаемого значения:
	boolean (логический)

Значения start-pos и end-pos могут быть отрицательными, что означает, что положение вычисляется с конца строки.

Пример:

tarantool> string = require('string')
---
...
tarantool> string.endswith('Baa', 'aa')
---
- true
...

string.lstrip(input-string)

Возврат значения введенной строки без пробелов слева.

Параметры:	input-string (string) – обрабатываемая строка
Возвращается:	результат после удаления пробелов из введенной строки
Тип возвращаемого значения:
	строка

Пример:

tarantool> string = require('string')
---
...
tarantool> string.lstrip(' ABC ')
---
- 'ABC '
...

string.rstrip(input-string)

Возврат значения введенной строки без пробелов справа.

Параметры:	input-string (string) – обрабатываемая строка
Возвращается:	результат после удаления пробелов из введенной строки
Тип возвращаемого значения:
	строка

Пример:

tarantool> string = require('string')
---
...
tarantool> string.rstrip(' ABC ')
---
- ' ABC'
...

string.split(input-string[, split-string[, max]])

Разделение input-string на одну или более выводимых строк в таблице. Места разделения указаны в split-string.

Параметры:	input-string (string) – строка для разделения split-string (integer) – искомая строка в пределах input-string. По умолчанию = пробел. max (integer) – максимальное количество символов-разделителей от начала обрабатываемой строки. Результат содержит не более max + 1 частей.
Возвращается:	таблица строк, которые были разделены из input-string
Тип возвращаемого значения:
	таблица

Пример:

tarantool> string = require('string')
---
...
tarantool> string.split("A:B:C:D:F", ":", 2)
---
- - A
  - B
  - C:D:F
...

string.strip(input-string)

Возврат значения введенной строки без пробелов слева или справа.

Параметры:	input-string (string) – обрабатываемая строка
Возвращается:	результат после удаления пробелов из введенной строки
Тип возвращаемого значения:
	строка

Пример:

tarantool> string = require('string')
---
...
tarantool> string.strip(' ABC ')
---
- ABC
...